Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

start: Data Access and Data Versioning to mention Model in titles (#2096) #2214

Merged
merged 29 commits into from
Mar 29, 2021
Merged

start: Data Access and Data Versioning to mention Model in titles (#2096) #2214

merged 29 commits into from
Mar 29, 2021
+61 −56

Conversation

iesahin
Copy link
Contributor

@iesahin iesahin commented Feb 18, 2021 •
edited by jorgeorpinel
Loading

UPDATE: Jump to #2214 (review)

Added changes from PR #2188 and modified paths & titles

Fixes #2096

  • Changes the title of "Data Access" to "Data and Model Access"
  • Changes the title of "Data Versioning" to "Data and Model Versioning"
  • Renames path of Data Access and Data Versioning to
    data-and-model-access.md and data-and-model-versioning.md
    respectively.
  • Adds redirects
    -- /doc/start/data-access -> /doc/start/data-and-model-access
    -- /doc/start/data-versioning ->
    /doc/start/data-and-model-versioning
  • Replaces links in /doc/start with the new links.

TODO

jorgeorpinel and others added 2 commits February 3, 2021 12:52
@jorgeorpinel
guide: disclaim x data (impro #2104)
4742d9c
@iesahin
Added changes from PR #2188 and modified paths & titles
8dea963 
- Changes title of "Data Access" to "Data and Model Access"
- Changes title of "Data Versioning" to "Data and Model Versioning"
- Renames path of Data Access and Data Versioning to
  `data-and-model-access.md` and `data-and-model-versioning.md`
  respectively.
- Adds redirects
-- `/doc/start/data-access` -> `/doc/start/data-and-model-access`
-- `/doc/start/data-versioning` ->
`/doc/start/data-and-model-versioning`
- Replaces links in `/doc/start` with the new links.
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue20-xpofzg February 18, 2021 11:13 Inactive
@iesahin iesahin mentioned this pull request Feb 18, 2021
Closed
@iesahin
Copy link
Contributor Author

iesahin commented Feb 18, 2021

I can replace all links to /doc/start/data-access and /doc/start/data-versioning with the new links. Is this OK?

@shcheklein
Copy link
Member

@iesahin looks good to me! let me know when it's ready to be merged, I see that you still have a TODO?

@shcheklein
Copy link
Member

We can also probably add Fixes #2096 to the description?

jorgeorpinel
jorgeorpinel reviewed Feb 18, 2021
View reviewed changes
redirects-list.json Outdated Show resolved Hide resolved
jorgeorpinel
jorgeorpinel suggested changes Feb 18, 2021
View reviewed changes
Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting there!

@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue20-xpofzg February 20, 2021 08:10 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue20-xpofzg February 20, 2021 09:05 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue20-xpofzg February 20, 2021 09:10 Inactive
@shcheklein shcheklein had a problem deploying to dvc-org-iesahin-issue20-xpofzg February 20, 2021 09:14 Failure
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue20-xpofzg February 20, 2021 09:52 Inactive
@iesahin

This comment has been minimized.

Sign in to view
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue20-xpofzg February 23, 2021 08:23 Inactive
@restyled-io restyled-io bot mentioned this pull request Feb 23, 2021
Merged
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue20-xpofzg February 24, 2021 11:21 Inactive
@iesahin
Merge pull request #2231 from iterative/restyled/iesahin/issue2096-ta…
6166ed0 
…ke-2

Restyle start: Data Access and Data Versioning to mention Model in titles (#2096)
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue20-xpofzg February 24, 2021 11:22 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue20-xpofzg February 24, 2021 11:52 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-iesahin-issue20-xpofzg February 24, 2021 12:12 Inactive
jorgeorpinel
jorgeorpinel reviewed Mar 29, 2021
View reviewed changes
content/docs/start/data-and-model-versioning.md Outdated
Comment on lines 250 to 258
## Model versioning

DVC helps you to handle model files as well. Models in a project usually change
more frequently than data files and they need to be kept in sync with changes in
other elements of a project. Model files are no different than data files when
it comes to tracking their versions. DVC also provides means to track minor
changes in model files without fully checking in to Git. In later sections of
this series, you'll see how DVC enables to track changes to synchronize multiple
model and data files.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Continuing #2214 (review)

I'm still not convinced we need this new section. We already say "data and models" in every section (except in Retrieving — let's fix that though), so if the gist here is that models are also tracked as any file normally, I think that's already implied in every other section.

Also, it can probably be summarized a bit (see feedback below) and then it's too short for a whole section anyway (could be moved to right before Storing and sharing if anything).

  • "usually change more frequently than data files" contradicts "are no different than data files" (at first sight)
  • "provides means to track minor changes in model files" - vague, what do we mean? run-cache, parameters etc. are not specifically for models.
  • The last sentence seems unnecessary.

jorgeorpinel
jorgeorpinel reviewed Mar 29, 2021
View reviewed changes
content/docs/start/data-and-model-access.md Outdated
Comment on lines 7 to 12
Okay, now that we've learned how to _track_ data and models with DVC and how to
version them with Git, next question is how can we _use_ these artifacts outside
of the project? How do I download a model to deploy it? How do I download a
specific version of a model? How do I reuse datasets across different projects?
We've learned how to _track_ data files in DVC and how to commit their versions
to Git. Machine learning models are typically large files written and read by
programs. DVC can track and version model files similar to data files. The next
questions are: How can we _use_ these artifacts outside of the project? How do I
download a model to deploy it? How do I download a specific version of a model?
How do I reuse datasets across different projects?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change seems to break the semantics of the paragraph. TBH I don't think it's necessary, we already state "data and models".

I do like the correction to the first sentence, "... , and how to commit their versions to Git" but the next 2 sentences are out of context here.

jorgeorpinel
jorgeorpinel approved these changes Mar 29, 2021
View reviewed changes
Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left 2 still-pending questions above ☝️

In order to merge this (the title and link changes should be useful, thanks @iesahin), I'm basically rolling back those 2 things (committing the suggestions below) but feel free to continue discussing/explaining and open another PR if needed.

content/docs/start/data-and-model-versioning.md Outdated Show resolved Hide resolved
content/docs/start/data-and-model-access.md Outdated Show resolved Hide resolved
@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Mar 29, 2021 •
edited
Loading

@shcheklein do we still want to merge this? If so I'll solve the conflicts and do so. Thanks

UPDATE: I guess so, since #2096 is labeled bug. So I solved the conflicts. But will let you merge just to double check since there are new redirects here. Thanks

@jorgeorpinel jorgeorpinel requested a review from shcheklein March 29, 2021 06:14
@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Mar 29, 2021 •
edited
Loading

p.s. everything here is link updates except content/docs/start/data-and-model-versioning.md and a bit more in data-and-model-access.md

@shcheklein shcheklein merged commit 1544cd5 into master Mar 29, 2021
@shcheklein shcheklein deleted the iesahin/issue2096-take-2 branch April 4, 2021 02:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shcheklein shcheklein shcheklein approved these changes

@jorgeorpinel jorgeorpinel jorgeorpinel approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

start: Data Access mentions tracking models without clarifying what kind
4 participants
@iesahin @shcheklein @jorgeorpinel @restyled-commits